<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdauiCombo: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="ch22.html" title="User interface API reference">
<link rel="prev" href="GdauiRawGrid.html" title="GdauiRawGrid">
<link rel="next" href="GdauiCloud.html" title="GdauiCloud">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdauiCombo.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdauiCombo.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GdauiCombo.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GdauiCombo.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch22.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdauiRawGrid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdauiCloud.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdauiCombo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdauiCombo.top_of_page"></a>GdauiCombo</span></h2>
<p>GdauiCombo — Combo box to choose from the contents of a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="vi-combo.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdauiCombo.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdauiCombo.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdauiCombo.html#gdaui-combo-new" title="gdaui_combo_new ()">gdaui_combo_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdauiCombo.html#gdaui-combo-new-with-model" title="gdaui_combo_new_with_model ()">gdaui_combo_new_with_model</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdauiCombo.html#gdaui-combo-set-model" title="gdaui_combo_set_model ()">gdaui_combo_set_model</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdauiCombo.html#gdaui-combo-add-null" title="gdaui_combo_add_null ()">gdaui_combo_add_null</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdauiCombo.html#gdaui-combo-is-null-selected" title="gdaui_combo_is_null_selected ()">gdaui_combo_is_null_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdauiCombo.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GdauiCombo.html#GdauiCombo--as-list" title="The “as-list” property">as-list</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *</td>
<td class="property_name"><a class="link" href="GdauiCombo.html#GdauiCombo--model" title="The “model” property">model</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdauiCombo.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdauiCombo.html#GdauiCombo-struct" title="struct GdauiCombo">GdauiCombo</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdauiCombo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkComboBox.html#GtkComboBox-struct">GtkComboBox</a>
                        <span class="lineart">╰──</span> GdauiCombo
                            <span class="lineart">╰──</span> <a class="link" href="GdauiProviderSelector.html" title="GdauiProviderSelector">GdauiProviderSelector</a>
</pre>
</div>
<div class="refsect1">
<a name="GdauiCombo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdauiCombo implements
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>,  <a href="/usr/share/gtk-doc/html/gtk3/GtkCellLayout.html#GtkCellLayout-struct">GtkCellLayout</a>,  <a href="/usr/share/gtk-doc/html/gtk3/GtkCellEditable.html#GtkCellEditable-struct">GtkCellEditable</a> and  <a class="link" href="GdauiDataSelector.html" title="GdauiDataSelector">GdauiDataSelector</a>.</p>
</div>
<div class="refsect1">
<a name="GdauiCombo.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgda/thread-wrapper/gda-thread-wrapper.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdauiCombo.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GdauiCombo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdaui-combo-new"></a><h3>gdaui_combo_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gdaui_combo_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new GdauiCombo widget.</p>
<div class="refsect3">
<a name="gdaui-combo-new.returns"></a><h4>Returns</h4>
<p>the newly-created widget. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-combo-new-with-model"></a><h3>gdaui_combo_new_with_model ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gdaui_combo_new_with_model (<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cols</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cols_index</code></em>);</pre>
<p>Create a new GdauiCombo widget with a model. See <a class="link" href="GdauiCombo.html#gdaui-combo-set-model" title="gdaui_combo_set_model ()"><code class="function">gdaui_combo_set_model()</code></a> for
more information about the <em class="parameter"><code>n_cols</code></em>
 and <em class="parameter"><code>cols_index</code></em>
 usage.</p>
<div class="refsect3">
<a name="gdaui-combo-new-with-model.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_cols</p></td>
<td class="parameter_description"><p>number of columns in the model to be shown</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cols_index</p></td>
<td class="parameter_description"><p>an array of columns to be shown, its size must be <em class="parameter"><code>n_cols</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-combo-new-with-model.returns"></a><h4>Returns</h4>
<p>the newly-created widget. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-combo-set-model"></a><h3>gdaui_combo_set_model ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_combo_set_model (<em class="parameter"><code><a class="link" href="GdauiCombo.html" title="GdauiCombo"><span class="type">GdauiCombo</span></a> *combo</code></em>,
                       <em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
                       <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cols</code></em>,
                       <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cols_index</code></em>);</pre>
<div class="warning"><p><code class="literal">gdaui_combo_set_model</code> has been deprecated since version 5.2 and should not be used in newly-written code.</p></div>
<p>Makes <em class="parameter"><code>combo</code></em>
 display data stored in <em class="parameter"><code>model</code></em>
 (makes the
combo widget refresh its list of values and display the values contained
in the model). A NULL <em class="parameter"><code>model</code></em>
 will make the combo empty
and disassociate the previous model, if any.</p>
<p>if <em class="parameter"><code>n_cols</code></em>
 is <code class="literal">0</code>, then all the columns of <em class="parameter"><code>model</code></em>
 will be displayed in <em class="parameter"><code>combo</code></em>
.</p>
<p><span class="annotation">[<a href="http://foldoc.org/skip"><span class="acronym">skip</span></a>]</span></p>
<div class="refsect3">
<a name="gdaui-combo-set-model.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>combo</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdauiCombo.html" title="GdauiCombo"><span class="type">GdauiCombo</span></a> widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_cols</p></td>
<td class="parameter_description"><p>number of columns in the model to be shown</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cols_index</p></td>
<td class="parameter_description"><p>an array of columns to be shown, its size must be <em class="parameter"><code>n_cols</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=n_cols]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-combo-add-null"></a><h3>gdaui_combo_add_null ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_combo_add_null (<em class="parameter"><code><a class="link" href="GdauiCombo.html" title="GdauiCombo"><span class="type">GdauiCombo</span></a> *combo</code></em>,
                      <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> add_null</code></em>);</pre>
<p>Tells if <em class="parameter"><code>combo</code></em>
 should add a special entry representing an "undefined choice", as a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> entry. The default is
that only the available choices in <em class="parameter"><code>combo</code></em>
's model are presented.</p>
<div class="refsect3">
<a name="gdaui-combo-add-null.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>combo</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdauiCombo.html" title="GdauiCombo"><span class="type">GdauiCombo</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>add_null</p></td>
<td class="parameter_description"><p>set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to add a NULL value to the combo box</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-combo-is-null-selected"></a><h3>gdaui_combo_is_null_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdaui_combo_is_null_selected (<em class="parameter"><code><a class="link" href="GdauiCombo.html" title="GdauiCombo"><span class="type">GdauiCombo</span></a> *combo</code></em>);</pre>
<p>Tell if the currently selected entry represents the "undefined choice" entry.</p>
<div class="refsect3">
<a name="gdaui-combo-is-null-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>combo</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdauiCombo.html" title="GdauiCombo"><span class="type">GdauiCombo</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-combo-is-null-selected.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value is selected</p>
</div>
<p class="since">Since: 4.2</p>
</div>
</div>
<div class="refsect1">
<a name="GdauiCombo.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdauiCombo-struct"></a><h3>struct GdauiCombo</h3>
<pre class="programlisting">struct GdauiCombo;</pre>
</div>
</div>
<div class="refsect1">
<a name="GdauiCombo.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdauiCombo--as-list"></a><h3>The <code class="literal">“as-list”</code> property</h3>
<pre class="programlisting">  “as-list”                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Owner: GdauiCombo</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiCombo--model"></a><h3>The <code class="literal">“model”</code> property</h3>
<pre class="programlisting">  “model”                    <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *</pre>
<p>Owner: GdauiCombo</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>